com.doclinx.ftxml
Class DPAPI_PARMS

java.lang.Object
  |
  +--com.doclinx.ftxml.ALL_PARMS
        |
        +--com.doclinx.ftxml.DPAPI_PARMS

public final class DPAPI_PARMS
extends ALL_PARMS

Parameter block class that controls optional functionality during the index build phase. The build phase creates all necessary structures and files to do full-text boolean search. Data structures for context and search enhancements such as fuzzy matching, stemming, and soundex-like are created. The parameters control functions such as memory allocation, context lookup structure creation, and stop word specification.

See Also:
catSetParms, catUpdate

Field Summary
 int dbuild_aliasMask
          Build alias mask - 0: do all
 char dbuild_contextAaidx
          Context aaidx. 0: NONE
 char[] dbuild_contextMap
          Internal Use Only (not user parameter)
 boolean dbuild_debug
          Turn on debug output.
 com.doclinx.ftxml.AltCallback dbuild_fzCallback
          Internal Use Only (not user parameter)
 int dbuild_memSize
          1/2 physical machine memory.
 int dbuild_merge2Threshold
          Level to do 2nd merge (10)
 boolean dbuild_noUpperCase
          Filter has already cased word
 com.doclinx.ftxml.AltCallback dbuild_stCallback
          Internal Use Only (not user parameter)
 java.lang.String dbuild_stopwordFile
          If specified, stop word file.
 int dbuild_stopwordLimit
          Word count #, make stop word
 int dpapi_error
          System/file error of failure
 byte dpapi_phase
          Which Step failed.
 java.lang.String dpapi_templateFile
          Template for .SYS file
 char invert_contextAaidx
          Context aaidx invert
 char[] invert_contextMap
          Internal Use Only (not user parameter)
 boolean invert_debug
          Turn on invert debug info
 java.lang.String invert_fastPath
          File path for fast device
 int invert_memSize
          Invert memory allocation size
 boolean invert_noUpperCase
          Filter has already cased word
 int invert_pct
          Memory partition %(33 def.)
 java.lang.String invert_tempPath
          File path for temporary files
 
Fields inherited from class com.doclinx.ftxml.ALL_PARMS
dc, dpapi_intermediateFiles, dpapi_recover, mk_bWeb, mk_cdMapString, mk_copyright, mk_databaseId, mk_debug, mk_fileSelect, mk_key, mk_memSize, mk_outputPath, mk_sequence, RECOVER_CAT, RECOVER_CATANDSTF, RECOVER_NONE, reorg_debug, reorg_memSize
 
Constructor Summary
DPAPI_PARMS()
          Constructor for initializing class values.
 
Method Summary
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dpapi_templateFile

public java.lang.String dpapi_templateFile
Template for .SYS file


dbuild_memSize

public int dbuild_memSize
1/2 physical machine memory.


dbuild_contextAaidx

public char dbuild_contextAaidx
Context aaidx. 0: NONE


dbuild_debug

public boolean dbuild_debug
Turn on debug output.


dbuild_stopwordFile

public java.lang.String dbuild_stopwordFile
If specified, stop word file.
    Comments on Usage: dbuild_stopwordFile 

    This full file path, if specified, indicates a UTF8 encoded text 
    file containing a list of words that are treated as stop words. 
    A stop word is typically defined as one that occurs so often
    as to have no meaningful specificity for a search. For instance,
    most articles (e.g. the word "a") do not provide useful context
    for a search. The format of the stopword file is a single word
    per line with no white space and ALWAYS in UPPERCASE.
    


dbuild_stopwordLimit

public int dbuild_stopwordLimit
Word count #, make stop word


dbuild_noUpperCase

public boolean dbuild_noUpperCase
Filter has already cased word


dbuild_merge2Threshold

public int dbuild_merge2Threshold
Level to do 2nd merge (10)


dbuild_aliasMask

public int dbuild_aliasMask
Build alias mask - 0: do all


dbuild_fzCallback

public com.doclinx.ftxml.AltCallback dbuild_fzCallback
Internal Use Only (not user parameter)


dbuild_stCallback

public com.doclinx.ftxml.AltCallback dbuild_stCallback
Internal Use Only (not user parameter)


dbuild_contextMap

public char[] dbuild_contextMap
Internal Use Only (not user parameter)


invert_memSize

public int invert_memSize
Invert memory allocation size


invert_pct

public int invert_pct
Memory partition %(33 def.)


invert_contextAaidx

public char invert_contextAaidx
Context aaidx invert


invert_debug

public boolean invert_debug
Turn on invert debug info


invert_noUpperCase

public boolean invert_noUpperCase
Filter has already cased word


invert_fastPath

public java.lang.String invert_fastPath
File path for fast device


invert_tempPath

public java.lang.String invert_tempPath
File path for temporary files


invert_contextMap

public char[] invert_contextMap
Internal Use Only (not user parameter)


dpapi_phase

public byte dpapi_phase
Which Step failed.


dpapi_error

public int dpapi_error
System/file error of failure

Constructor Detail

DPAPI_PARMS

public DPAPI_PARMS()
Constructor for initializing class values.

Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object